BBS Toolkit/BBS Toolkit.iso/qbbs/tdplus20.zip/TDOOR.DOC

Text File | 1992-05-16 | 26KB | 619 lines

           ╓──────────────────────────────────────────────╖
           ║      Welcome to The Transfer Door v2.00      ║
           ║                                              ║
           ║    (c) Copyright 1991,92 Gary Blydenburgh    ║
           ║                                              ║
           ║             ALL RIGHTS RESERVED              ║
           ╙──────────────────────────────────────────────╜


                             DESCRIPTION
                             -----------

   The Transfer Door is an external Door Run as a Type 7 or 15  exit
   from QuickBBs, Remote Access, or SuperBBS. Remote Access has it's
   own  version.  It  is designed to replace the file section of you
   BBS with a more versitile file area. This version supports Remote
   Access 1.10 file structures, and QuickBBS 2.75




                              FEATURES
                              --------
   o Menus Sysop configurable ALA QuickBBS/RA
   o TDPLUS swaps to disk or EMS on shells
   o CD ROM Support
   o Built in Sysop FILES.BBS Maintenance
   o Multiple line file descriptions
   o Private files Supported
   o Define as many free areas as you want
   o # of file directories on 1 line is sysop configurable
   o Looks for Help file (help.td)
   o Filename search for unwanted files (FILE.LST)
   o File tagging for Ansi users
   o Tape Drive Support! Will restore MISSING files
   o Will display Upload.ans or asc before uploads if it exists
   o Goodbye from Tdoor Sysop Configurable
   o User may Toggle Graphics on and off
   o Hot Keys now installed! Sysop Configurable
   o Full Communications Support
   o No Watchdog or CTTY needed
   o Uses ANSI so the Sysop sees what the user sees
   o Status line display
   o Keyboard inactivity timeout
   o Sysop Chat with word wrap
   o Shell to DOS option for Sysop
   o Sysop can return caller to BBS
   o Support for Errorlevel, or DSZLOG type Protocols, or Other
   o Configuration Program to set up system
   o Up to 60 Protocols may be defined in Config file
   o Keeps track of all Ratios imposed by bbs instantly!
   o Direct BIMODEM support without external programs
   o Complete security by Flags and Security level
   o Scans all areas users has access to for D/L's
   o Checks for duplicate uploads
   o Scans for Virus and reArcs uploads files to your arc
     Format  with  ZZAP  v54a  and  newer,  and VIRUSSCAN, sample
     zzap.cfg included, also may use Ziplab
   o Virus Scan software now sysop configurable
   o Support for External Archive Viewer such as Zipster
   o D/L hours, min baud rate, and D/L exempt
   o Default file extension support
   o Supports batch Transfers
   o Wildcard Support for file searches
   o All files are opened in Shared mode for Multinode Support
   o Sysop may use his own Ansi and Ascii menus
   o Will not show FILES.BBS or FILES.BAK
   o Shows blinking * in file list for new files
   o Multi-line menu descriptions
   o New file search from any date
   o D/L or U/L while listing files
   o Built in FilesCounter supports [1] and <1> methods
   o Upload Credit Sysop configurable
   o Supports locked baud rates
   o Creates Up and download logs in default directory
   o configurable upload directories
   o Many other features not listed!
   o Displays UPLOADS.ANS/ASC if found before an upload


There are now 2 versions of the Transfer Door. Tdoor.exe and Tdplus.exe
The latest versions may be requested as TDOOR and TDPLUS from 374/30 At
HST and V32B speeds.

Tdplus uses external user defined menus, use you favorite menu editor
to edit the menu to your taste. Tdplus also no longer uses FILES.BBS,
although it still updates Files.bbs on uploads, and moving of files with
the sysop options.
TDPLUS now uses FILES.TD. This file keeps track of:
File name, File Date, File Size, Upload Date, # of D/L's, Uploader, and description
A utility has been added to convert your Files.bbs to Files.td. File dates
are no longer touched by this version, new file searches are compared
against the upload date in files.td.

Tdoor.exe is the same as Tdplus.exe except the menus are built in, and it still
uses Files.bbs



                   SETTING UP THE TRANSFER DOOR
                   ----------------------------
File Tagging is supported, Users may tag up to their D/L or time limit,
Tags are not lost till the file is downloaded. When the users limit is
reached, the file will not accept a Tag. Tagged files are lost if a user
does a "Regular" D/L.

The files counter now supports [1] or <1>, it will update whatever it finds

Place the following files into your BBS or TDOOR Directory: if you put
Tdoor in its own directory, you will need to copy Dorinfo1.def to that
directory, then copy it back after exiting Tdoor.

            TDOOR.EXE or TDPLUS.EXE
            TDOOR.MNU (Tdplus only)
            PROTOCOL.TD
            FLSEARCH.TD
            TDOOR.CNF
            TDCONFIG.EXE
            HELP.TD
            FILE.LST (if you use this option)
            TDOOR.ANS (Change it to your taste)



SETTING THE DSZ ENVIRONMENTAL VARIABLE
--------------------------------------
First of all you must set the enviromental variable for DSZLOG, Put the
following command in your autoexec.bat SET DSZLOG=C:\pathtobbs\DSZ.LOG

If you leave this out, your transfers will not be counted unless they are
the Errorlevel type. Please note the filename DSZ.LOG can now be any name
you like as Tdoor now reads the variable you set.

Tdoor nows checks the enviromental variable for DSZLOG internally if it is
not set properly, you will exit with an Error.


MAIN MENU
---------

TDOOR.EXE:
The menus are built in. it uses Tdoor.ANS/ASC for the display. This file
must be present. This version is for those of you that don't want to mess
around with making your own menus.

TDPLUS.EXE:
The Main and file menus are Sysop configurable, it uses the same menu structures
as QuickBBS and RA. You may use Menu Master or another similar program to
create your menu. The menu choices are limited, but to stay
compatable, I have used the same menu Type numbers as Quick and RA for the
features that I do support. I have enclosed a sample menu for you to work
with. ^A autostart selections are available, but only for use of an ANSI
menu. If you want to use your own ansi menu, make the first line on your
menu a Type 5, and put ^A for the Key.

The Menu name is configured in Tdconfig, you may path it.

Menu Selections Supported:

Type    Function                   Data
----    --------                   ----
0       Blank Line                 None
1       Goto new menu              Path and complete menu name; c:\quick\menus\tdoor.mnu
5       Display Ansi/Ascii File    Filename minus the extention
7       Shell and run program      Program Name
9       Goodbye/Loggoff            None
21      Toggle Ansi on/off         None
31      List Files.td              Flsearch.td record number of this area
32      Download                   None
33      Upload                     None
35      Keyword Search             None
36      File Search                None
37      New File Search            None
38      View Text File             Path to text file, user is prompted for Text Filename
39      View Text File             Full path and filename of text file
48      D/L a certain File         Full path and filename to D/L
71      User Stats                 None
90      Return To BBS              None
98      Enable or Disable hotkeys  E or D
99      Select Transfer Protocol   None

Type 90 is one I made up, as Quick and RA have no Return to BBS function.
All menu choices can oly be used once except types 1,5,7,31,38,39. I did this to
conserve memory, as these 3 are the only real ones that you may want to use
more than once. Although it is limited, at lease you may now configure Tdoor
with your own Colors, Keypresses, and menu choices. This is the only menu
that will be configurable. Highlites are also supported(prompt will be),
define them with menu master.

TDOOR CONFIGURATION FILES
-------------------------

                                FILE AREAS
                                ----------
If converting from FLSEARCH.CTL run QB2TDOOR.EXE
If converting from FILES.RA run RA2TDOOR.EXE
they will do most of the conversion for you
Make sure you run Tdconfig and go over all the conversions.

DLPATH:
        The complete path to this D/L area.

AREA:
        The Name of the file area, spaces are allowed "" are not

ULPATH:
        Where you want uploaded files placed for this area. I would
        put them all in a special uploads directory, but many sysops
        don't do this and want the files uploaded to the D/L directory

FILESBBS:
        Enter full path and name of your file lists(Files.bbs or Files.td
        for TDPLUS). It may now be a separate directory, for CD ROM support.

SECURITY:
        Security level for this area

FLAG:
        Flag for this area. Enter XX is no flag is required.

FREE AREA:
        If you want this area to be free then set this to "Y". Any files
        D/L'ed from this area will not be counted against Ratio checks.


GLOBAL SEARCHES:
        If you do not want the area included in global New file search or
        Upload dupe file search, then put "N" here, put "Y" otherwise.
        This is useful if you have CDROMS and don't want them searched all
        the time for new files, as their dates are never new.

UPLOADER:
        Used by TDPLUS to determine if you want the uploaders name listed
        in this file area.



                                PROTOCOLS
                                ----------

KEYPRESS:
        The key to activate this protocol

DESCRIPTION:
        The menu selection displayed to user.

NUMBER of FILES ALLOWED:
        This is the # of files you want to allow in batch transfers. If the
        protocol does not allow batch transfers, enter 1.

DOWNLOAD AND UPLOAD COMMANDS:
        This is the actual command that is shelled to from tdoor, my examples
        are set up for COM1, you may need to edit them
        The filename MUST CONTAIN THE COMPLETE PATH AND FILENAME OF PROTOCOL

ERRORLEVEL:
        Protocols are set up with [D]sz.log [E]rrorlevel or [O]ther to check
        whether the transfer was a success, D and E are the best choices to use,
        but some protocols need another way to test. This is done by comparing the
        transfer time, with the estimated transfer time, it is not the best method
        for testing, use the first two if at all possible.

EFFICIENCY:
        Used for [O]ther type protocols. This number is multiplied against the
        transfer time to compare if the transfer was a success or not.

When using BIMODEM be sure to set up your upload directory in BiConfig the same as the
directory configured in your Door.cnf file. Bimodem.cfg must also be in
your BBS directory


                                TDOOR.CNF
                                ----------

BBS PATH:
        Path to bbs exitinfo.bbs and dorinfo1.def

BBS NODE:
        Enter the number of the node being run from, this is for the filename
        of the tdoor swap file

USE DIRECT SCREEN WRITES:
        Enter Y for yes or N for bios writes.

DUPE UPLOAD CHECK:
        Enter "F" to have dupe checking against your files.bbs
        ENTER "D" to check the directory
        "D" is faster, but if you have offline files you do not want uploaded
        you will wnat to set this as "F"

BBS LOG:
        Path and name of your BBS log file.

ZIP VIEW PROGRAM:
        The name of your Archive viewing program, Zipster, and MTS are the 2 best.
        Leave line blank if you do not use one.

DEFAULT ARCHIVE EXTENSION:
        Enter the archive extension you use on your bbs. This allows the user
        to input just FILE for FILE.ZIP

MINIMUM BAUD RATE:
        Minimum baud rate allowed to use TDOOR, The user will be kicked out
        Of the door if he is less than this rate.

D/L HOURS:
        Enter D/L hours of your bbs. Do not span midnight.

ENABLE FILES.BBS SORT ROUTINE:
        Enable this if you want the files.bbs that you move files to with the
        sysop maint <M>ove files command

FILE MAINT SECURITY:{Tdoor.exe Only}
        Enter the security level to have access to the Special Sysop Functions

MENU:
        The full path and name of your Tdoor menu file(TDPLUS only)

DEFAULT UPLOAD DIR:
        Name of you upload Directory, if uploads are made from main menu. Uploads
        made at file areas will go to the directory specified in that file area.

ENABLE VIRUS SCAN:
        Enable this if you want your uploads checked for Virus, and/or archive
        type conversion with ZZAP or another program of this type. You must have
        ZZAP and SCAN from MCCaffe in your path.

1ST COMMAND:
        This the command for uploads that are archived when Virus Scan is enabled.

2ND COMMAND:
        this is the command for uploads that are not Archived

TAPE:
        Enable this if you want Missing files in your files.bbs restored from
        your tape drive and made available to the user for Download.

        In TDCONFIG there are 3 parameters for Tape Support.

        o Enable Support by Entering E in the approriate field.
        o Enter a Temporary Directory for restored Tape files.
        o Enter You Tape Command String.

        Tdoor will replace F$ with the filename in your tape command string.  Be
        sure to restore all files to the Temporary Tape directory, they will be
        D/Led from there, and deleted after the transfer.

        For CMS Jumbo you create D:\TAPE\ as your Temp directory in Tdoor.cnf.  The
        tape must be formatted as 1 single directory called TAPE then use:

        TAPE RESTORE \TAPE\F$

        Create a Temporary directory of the name configured in TDCONFIG.

        That's it, if a user comes across a file that is Listed in your FILES.BBS,
        but not found on the disk, it will give the option of Restoring the file
        from the tape drive. The file must be listed in the files.bbs to be
        restored.

        Most Tape drives do not work under DesqView, i have enclosed a Sample of
        EZTAPE from Irwin Magnetics, as the is the drive that I use. If you need a
        bigger command string, just edit Tdoor.cnf with a text editor.

        Be sure to disable you modem from hanging up if user activity is too long,
        as it takes a while to get the files off the tape as you know.

D/L RATIO EXEMPT FLAG:
        Enter the flag you wish to use to exempt the user from ant Ratio
        checks. The time limit is still enforced.
        Enter "XX" if you do not want to use Ratio checking at all

# OF FILE DIRECTORIES: {Tdoor.exe only}
        The number of file directories on 1 line is now configurable to 2 or 3
        across. Also note that if you have more than 33 file areas you must disable
        hot keys, as you will run out of menu choice characters for file area
        selections. When hot keys are off, the file areas are numbered instead of
        using single chars. You may now define up to 200 file areas. Also if you
        have more than 99 file areas your area description length for 2-column
        mode may only be 30 characters, 3-column mode 20 characters.

FILE RATIO
        Enter the ratio you want to use on your BBS. You must put a number here
        even if you do not want to use ratio checking. The Ratio flag will disable
        ratio checking if you don't want to use it.

FILE RATIO CHECK TYPE:
        Enter # if you want your Ratio checked buy number of files, or K if you
        want them checked in kilobytes

DL's BEFORE RATIO CHECK:
        Enter the number of D/L's a user can have before his ratio is checked.
        it would not be fair to the user to make him have to upload before he
        can even D/L. But I guess you can if you want!

D/L FILES COUNTER:
        Enter E to enable the d/l files counter or D to disable it.

BBSTYPE:
        Enter QUICKBBS For QuickBBS or SuperBBS, or REMOTE ACCESS, for RA.

ENABLE HOT KEYS:
        Do not enable HOT keys if you have more that 33 file areas, as you
        will run out of menu choice chars. When Hot keys are disabled menu
        choices for file areas will ne numbered instead of lettered.

        The number of the keypress will be the same as the order of entry
        in The File Menu, The 1st file area found will be 1, the second will
        be keypress 2, the 3rd will be 3, etc.... The menu keypresses will
        be overridden and numbers will be used instead when hot keys are disabled

        Use menu option 98 to disable hot keys at the top of your file menus if
        you want to use numbered areas, be sure to use it again to re-enable
        hot keys at the main menu. This allows you to still use hot keys from
        your other menus.

PRIVATE FILES:
        If enabled user will be prompted to ask if the file being uploaded
        will be for sysop eyes only. If so the upload will be moved to the
        Private file directory.

DIR:
        This is the directory used with above command. It must be listed
        if Private files are enabled.

U/L CREDIT:
        Time credit given to user for upload. If set to 1 no time will be
        lost for uploads. If set to 2, user will have double upload time
        credited to him. If set to 0, no credit is given. ETC...

LOG OFF FROM TDOOR:
        Allow user to log off within Tdoor.

SWAP:
        Enter E to swap to EMS, D to swap to disk, N to Disable swapping
        when running external programs. If you have trouble with this routine
        disable it.

FILE DESCRIPTIONS:
        Enter the maximum # of lines you want in your file descriptions.
        minimum or 1, max or 5.

                          ──────────//──────────

USER CREATED MENU
-----------------
Tdoor needs TDOOR.ANS or TDOOR.ASC for it's Main Menu. Do not use screen clearing
in you ansi menu or you will lose the status bar. TDPLUS uses user defined menus
TDOOR.ANS/ASC is used in the default menus supplied with TDPLUS

Please note if your Files.bbs has a header, be sure to put a SPACE before
it.

Tdoor also creates UPLOADS.LOG and DOWNLOAD.LOG in the default directory,
the system log is also updated.

To Run as a Type 15 Door insert the following into your bat file:

      if errorlevel 90 goto Tdoor
      .
      .
      .

      :tdoor
      TdPLUS.exe /Ctdoor.cnf /PProtocol.td
      Quickbbs -e0 -r
      goto after_Quick

To run as a Type 7 door just put TDPLUS.EXE /CTDOOR.CNF /PProtocol.td
on your menu make sure you use the *M command with type 7 exits!

If you do not specify a config file TDOOR.CNF and PROTOCOL.TD are assumed


UNWANTED FILES
--------------
Tdoor checks to see if FILE.LST exists in current directory. This file is a
list of unwanted filenames and is checked against uploads. It will not
allow any file in this list to be uploaded. just enter 1 filename per line.
Sample is enclosed.


HELP FILE
---------
A Help file may be added as HELP.TD and a sample is enclosed. Create/Add to
it whatever you want to include to assist your users.

MULTINODE
_________

Create a TDOOR directory and palce all the tdoor files in it.
Create a separate Tdoor.cnf for each node and name each different.
Make sure the BBS directory points to each nodes directory
Make sure you rename DSZLOG to a different filename for each node
Create a separate protocol.td and do the same reflecting the com port differences.

Call Tdoor with the config files as:
                                     TDPLUS /CTdoor.cnf /PProtocol.td

SYSOP MAINTENANCE
-----------------
In TDPLUS.EXE it is a separate program , SYSOP.EXE. It can be accessed from
a type 7 exit from you main menu. You may also run it from QuickBBS if you choose.
RUN As SYSOP.EXE TDOOR.CNF
Please note no /C in this program for the config file!

TDOOR.EXE:
Sysop maint is toggled on and off at the File Directory screen. It is by
default OFF, and is toggled on with the [!] key. Anyone with a security
level >= the Sysop Maint security entered in Tdoor.cnf will have acces to
these special commands. You must have ANSI enabled to use this section

When this section is made active, the sysop commands are displayed at the
end of each page while listing files. These are the commands available.

Move Tags:
        You may tag up to 30 files at a time and move them to any file
        directory listed in FLSEARCH.TD. You may only work with 1 File
        area at a time. If you leave the file area, all tags are lost.
        If you have Sort files.bbs enabled in Tdoor.cnf then the files.bbs
        that you have moved the files to will be sorted in alphbetical order

Edit:
        Edit the file description of the line you are on. An ansi editor
        is used for this, with full editing features.

Kill:
        Delete the file you are on.

Sort:
        Sort the Files.bbs that you are now listing.

Date:
        Change the file date of all tagged files to Todays Date, files
        will then show up with a New files search.


TDUPDATE.EXE
        This program is used to convert FILES.BBS to FILES.TD for TDPLUS.
        TDPLUS uses a new file listing which includes the uploaded file
        date, the uploaders name, # of Downloads, and a longer file
        description. Just run it in the same directory as you FLSEARCH.TD
        file, it will update or create a new FILES.TD for you. Two command
        line options are available to you. /A will run unattended, /D will
        make the Upload date todays date, otherwise the Upload date will be
        the file date. You may still use FEBBS or whatever you use to do
        your file maint. Then run TDUPDATE to convert the changes over to
        FILES.TD in your nightly event.


                          ──────────//──────────


                          Error Codes For Tdoor

 2 Syntax Error                 53 File Not Found
 3 Return without Gosub         54 Bad File Mode
 4 Out of Data                  55 File Already Open
 5 Illegal Function Call        56 Field Statemant Active
 6 Overflow                     57 Device I/O
 7 Out Of Memory                58 File Already Exists
 9 Subscript out of Range       59 Bad Record Length
10 Dupe Definition              61 Disk Full
11 Division by 0                62 Input past end of file
13 Type mismatch                63 Bad Record #
14 Out of string space          64 Bad file name
16 String formula too complex   67 Too many files
19 No Resume                    68 Device unavailable
20 Resume without error         69 Comm buffer overflow
24 Device timeout               70 Permission denied
25 Device fault                 71 Disk not ready
27 Out of paper                 72 Disk media error
39 Case else expected           73 Advanced Feature Unavailable
40 Variable required            74 Rename Across disks
50 Field overflow               75 Path/File access error
51 Internal Error               76 Path not found
52 Bad file name or #

                          ──────────//──────────


Tdoor Beta sites:

  Lounge Lizard's Retreat 382/8    [phone] George Vandervort
  Hurricane Alley BBS     266/901  [phone] Al Chavez
  Shadowdale              130/28   [phone] Mike Wilson
  Middle Earth            382/19   [phone] Jim Roe
  The Private Ear         388/10   [phone] Fred Horner
  The Allied Group BBS    268/108  [phone] Robert Zellers
  The Endeavour           363/330  [phone] Jade Apisukh
  The Ham Radio Emporium  170/801  [phone] Chester McCarter
  T.I.T.S BBS             363/678  [phone] Blaine Richard
  Mass Connections BBS    324/288  [phone] James Ouellette
  Cubic BBS (Canada)      221/124  [phone] Dave Gee
  Adult Fun Castle BBS    3613/9   [phone] Robert Carter
  Free New York Net       2603/0   [phone] E. Deringer
                          ──────────//──────────


This program is Shareware, You may use it for an Evaluation period of 30
days, if you like it a Registration fee of $20_US is greatly appreciated!
This program may not be modified in any way! A Key file will be sent to you
to take the evaluation copy message out of you copy.

The current version of Tdoor may be freq'ed from 324/126 under magic name
of TDOOR or TDPLUS.

Registering your software will encourage future updates!

Send Registrations and questions to:
                                      Gary Blydenburgh
                                      36 Briarwood Rd
                                      Haverhill, Ma 01832
                                      Fidonet 324/126
                                      BBS 1-508-372-3013 HST D/S